IGroup.Jog method

Commands a never-ending controlled motion at a specified velocity for an axis group.

Assembly: IntervalZero.KINGSTAR.Base.Class (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB

IGroupJogCommand Jog(
       double[] velocity,
       double acceleration,
       double deceleration,
       double jerk
)

Function Jog(
       velocity As Double(),
       acceleration As Double,
       deceleration As Double,
       jerk As Double
)As IGroupJogCommand

Parameters

velocity

Type: double[]

A value of the specified velocity. [unit/second]

acceleration

A value of the acceleration. The unit is determined by the McProfileType type. (increasing energy of the motor) [unit/second²] or [second]

deceleration

A value of the deceleration. The unit is determined by the McProfileType type. (decreasing energy of the motor) [unit/second²] or [second]

jerk

A value of the jerk. The unit is determined by the McProfileType type. [unit/second³] or [second]

Return value

Returns a state of a group's jog move.

Remarks

Because IGroup.Jog keeps controlling the axis, it triggers an error if a limit is reached.
The Velocity, Acceleration, Deceleration and Jerk are for each axis in the group, not for the path values. If one of these parameters' values, for example, Acceleration, exceeds the maximum Acceleration of one of the axes in the group, the axis will use its own max Acceleration value. Other axes use the provided values.
Velocity can be modified when the axis group is running.
IGroup.Jog can be used only in the GroupStandstill state.